Skip to main content

Endpoint Profile by ID

Route

/v2/endpoint-management/profiles/{id}

Description

Retrieve a profile, update its metadata or targeting, or delete it when it is no longer applied.

Methods

  • GET — fetch a profile by ID
  • PATCH — update profile fields
  • DELETE — delete a profile

Inputs

ParameterTypeRequiredDescription
idstringYesProfile ID in the path
profileUpdateProfileYes (PATCH)Fields to update (name, description, status, priority, applied_configurations, uninstall_enabled, targeting, override_configuration)
fieldsstringNo (PATCH)Comma-separated list of fields to update

Request Example (PATCH)

{
"description": "Updated messaging for the secure Mac fleet profile.",
"priority": 150,
"targeting": {
"type": "cel",
"query": "device.os == \"macos\" && device.is_corporate"
}
}

Output (GET/PATCH)

FieldTypeDescription
typestringAlways "profiles"
sizeintegerNumber of profiles returned
resourcesarray[Profile]Profile object
errorsarray[Error]Any errors

Profile Object (key fields)

FieldTypeDescription
idstringProfile identifier
namestringProfile name
descriptionstringDescription
typestringProfile type
statusstringProfile status
applied_configurationsAppliedProfileConfigurationsAttached configuration modules
uninstall_enabledbooleanRemote uninstall allowed
priorityintegerPriority for targeting
targetingTargetingTargeting rules
override_configurationobjectAdditional JSON overrides

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response (GET)

{
"type": "profiles",
"size": 1,
"resources": [
{
"id": "profile-secure-laptops",
"name": "Secure Laptops",
"description": "Updated messaging for the secure Mac fleet profile.",
"type": "endpoint_sensor",
"status": "active",
"applied_configurations": {
"performance_configuration": "config-performance",
"detection_configuration": "config-detection"
},
"uninstall_enabled": false,
"priority": 150,
"targeting": {
"type": "cel",
"query": "device.os == \"macos\" && device.is_corporate"
}
}
],
"errors": []
}